Markdown Syntax
This page showcases various markdown syntax and demonstrates how they are rendered.
Typography
Headings
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Text formatting
**Bold text**
*Italic text*
~~this puts a strikethrough~~
==this highlights text==
**Bold text and _nested italic_ text**
***Bold and italic text***
Bold text
Italic text
this puts a strikethrough
this highlights text
Bold text and nested italic text
Bold and italic text
Images
embed images
Image names should be unique. Duplicate images will be overwritten.
Image paths should be relative to vault root. If you are using
Obsidian, you can configure this to automatically handle it.
Refer Usage for more details.
The following image
formats are supported: jpeg, jpg, png, webp, svg
.
![[image.png]]
![](image.png)
![[test.webp]]
external images
![Engelbart](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg)
Wikilinks
For wikilinks to be rendered correctly, the path should be relative to the vault root. If you are using Obsidian you can easily configure it to automatically do this without having to change your workflow. Refer to Usage for more details on how to do this.
[[Installation]]
[[release notes/backend]]
Footnotes
This is a simple footnote[^1].
[^1]: This is the referenced text.
[^2]: Add 2 spaces at the start of each new line.
This lets you write footnotes that span multiple lines.
[^note]: Named footnotes still appear as numbers, but can make it easier to identify and link references.
This is a simple footnote1.
Quotes
> Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.
\- Doug Engelbart, 1961
Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.
- Doug Engelbart, 1961
Tables
| First name | Last name |
| ---------- | --------- |
| Max | Planck |
| Marie | Curie |
First name | Last name |
---|---|
Max | Planck |
Marie | Curie |
The vertical bars on either side of the table are optional.
Cells don't need to be perfectly aligned with the columns. Each header row must have at least two hyphens.
First name | Last name
-- | --
Max | Planck
Marie | Curie
First name | Last name |
---|---|
Max | Planck |
Marie | Curie |
Mermaid diagrams
Markopolis supports mermaid charts.
Large chart
Callouts
Markopolis also supports Obsidian style Callouts. However, as of now custom callouts aren't supported. Only the following base Obsidian callout types are supported.
Foldable callouts
You can make a callout foldable by adding a plus (+) or a minus (-) directly after the type identifier.
A plus sign expands the callout by default, and a minus sign collapses it instead.